org.eclipse.vtp.framework.core
Interface ISessionContext

All Superinterfaces:

IContext, ILogger, IProcessContext, IReporter

All Known Subinterfaces:

IActionContext, IExecutionContext

All Known Implementing Classes:

AbstractActionContext, AbstractExecutionContext, AbstractSessionContext, ActionContextWrapper, Execution.Context, ExecutionContextWrapper, Sequence.Context, Session.Context, SessionContextWrapper

public interface ISessionContext
extends IProcessContext

A service available to all services at any scope except the process scope.

Author:

Lonnie Pryor

Field Summary

Fields inherited from interface org.eclipse.vtp.framework.core.IReporter

SEVERITY_DEBUG, SEVERITY_ERROR, SEVERITY_INFO, SEVERITY_WARN

Method Summary

void	clearAttribute(java.lang.String attributeName) Clears the value of a session-level attribute.
java.lang.Object	getAttribute(java.lang.String attributeName) Returns the value of a session-level attribute with the specified name or null if no such attribute exists.
java.lang.String[]	getAttributeNames() Returns the names of all the session-level attributes currently registered.
java.lang.String	getSessionID() Returns the ID of the current session.
void	setAttribute(java.lang.String attributeName, java.lang.Object attributeValue) Sets the value of a session-level attribute or clears it if the supplied value is null.

Methods inherited from interface org.eclipse.vtp.framework.core.IProcessContext

getProcessID, getProperty, loadClass

Methods inherited from interface org.eclipse.vtp.framework.core.IContext

lookup, lookupAll

Methods inherited from interface org.eclipse.vtp.framework.core.ILogger

debug, debug, debug, debug, error, error, error, error, info, info, info, info, isDebugEnabled, isErrorEnabled, isInfoEnabled, isWarnEnabled, log, log, log, log, warn, warn, warn, warn

Methods inherited from interface org.eclipse.vtp.framework.core.IReporter

isSeverityEnabled, report, report, report, report

Method Detail

getSessionID

java.lang.String getSessionID()

Returns the ID of the current session.

Returns:

The ID of the current session.

getAttributeNames

java.lang.String[] getAttributeNames()

Returns the names of all the session-level attributes currently registered.

Returns:

The names of all the session-level attributes currently registered.

getAttribute

java.lang.Object getAttribute(java.lang.String attributeName)
                              throws java.lang.NullPointerException

Returns the value of a session-level attribute with the specified name or null if no such attribute exists.

Parameters:

attributeName - The name of the session attribute to return.

Returns:

The value of a session-level attribute with the specified name or null if no such attribute exists.

Throws:

java.lang.NullPointerException - If the supplied attribute name is null.

setAttribute

void setAttribute(java.lang.String attributeName,
                  java.lang.Object attributeValue)
                  throws java.lang.NullPointerException

Sets the value of a session-level attribute or clears it if the supplied value is null.

Parameters:

attributeName - The name of the session attribute to set.

attributeValue - The value to set the attribute to or null to clear the attribute.

Throws:

java.lang.NullPointerException - If the supplied attribute name is null.

clearAttribute

void clearAttribute(java.lang.String attributeName)
                    throws java.lang.NullPointerException

Clears the value of a session-level attribute.

Parameters:

attributeName - The name of the session attribute to clear.

Throws:

java.lang.NullPointerException - If the supplied attribute name is null.